home *** CD-ROM | disk | FTP | other *** search
/ Megahits 3 / Megahits 3 (1994)(GTI - Rhein-Main-Soft)(DE)[!].iso / module / utilities / optimod / optimod.doc < prev    next >
Text File  |  1994-10-14  |  15KB  |  414 lines
  1. (OS2.0 Only)
  2.  
  3.     Q-TECH Tools...
  4.  
  5.                              O P T I  M O D
  6.  
  7.                               version 4.00
  8.  
  9.  
  10.             - THE PROTRACKER/NOISETRACKER MODULE OPTIMIZER -
  11.  
  12.  
  13.                          Written by Joakim Ögren
  14.  
  15.  
  16.       (C) Copyright 1992,93 Quality Technology - All rights reserved
  17.  
  18.  
  19.  
  20.  1. Distribution
  21.     ¯¯¯¯¯¯¯¯¯¯¯¯
  22.       All these programs are copyrighted by Quality Technology. But
  23.     they are freely distributable as long as it's not included in any
  24.     comercial product or sold for a price higher than the cost for the
  25.     disk and drive use. All documents and files must always be kept
  26.     together. The only exception is when it's copied to eg a harddrive
  27.     for own use. You are not allowed spread it unless it's a 100%
  28.     complete package. You are neither allowed to spread it if any file
  29.     is changed. The best way to distribute it, is in a LhA archive.
  30.      It may not be included in any comercial products without contacting
  31.     the author before.
  32.  
  33.       All files are also classified as SHAREWARE. That means that you are
  34.     not allowed to use for a longer time than two weeks it if you haven't
  35.     paid the shareware fee. But you are allowed to distribute it. More
  36.     about the shareware fee later.
  37.  
  38.       Fred Fish have the right to include OptiMod in his Amiga Library.
  39.     Other makers of PD-series also have the right to include it as long
  40.     as all rules above are respected.
  41.  
  42.       Please respect these rules, and I will continue to make new
  43.     versions of OptiMod.
  44.  
  45.     All files:
  46.  
  47.       OptiMod                    MainProgram
  48.       OptiMod.doc                Documenation
  49.       OptiMod.doc.info           icon
  50.       OptiMod.history            Historyfile
  51.       OptiMod.history.info       icon
  52.       OptiMod.RegForm            Registration form
  53.       OptiMod.RegForm.info       icon
  54.  
  55.  
  56.  
  57.  2. Disclaimer
  58.  ¯¯¯¯¯¯¯¯¯¯¯¯¯
  59.       The author cannot be held liable for the suitability or accuracy of
  60.     this manual and/or the program(s) it describes. Any damage (software
  61.     or hardware damage) directly or indirectly caused by the use or misuse
  62.     of this manual and/or the program it describes is the sole responsibility
  63.     of the user her/him self.
  64.  
  65.  
  66.  
  67.  3. Author
  68.  ¯¯¯¯¯¯¯¯¯
  69.       OptiMod is written by Joakim Ögren in assembler to get the
  70.     program as short and fast as possible. OptiMod requires
  71.     OS2.0 (V37+) to run, since it uses many of 2.0 features to
  72.     get it as fast,short and powerfull as possible. If you only
  73.     have 1.3 or lower I can only say: Upgrade :-)
  74.  
  75.  
  76.  
  77.  4. Purpose
  78.  ¯¯¯¯¯¯¯¯¯¯
  79.       OptiMod is a utility to optimize NoiseTracker and ProTracker
  80.     modules. All modules must be in the 31 instruments fileformat
  81.     and be a ProTracker/NoiseTracker module. ie OptiMod won't
  82.     accept any StarTrekker or 15 instruments SoundTracker modules.
  83.     To use OptiMod on any of them please load them into ProTracker
  84.     (or some other Tracker) and save it again.
  85.  
  86.       OptiMod started when I saw that most modules were longer than
  87.     they would have to be. And the stupid fileformat of modules doesn't
  88.     make it shorter. Some other authors have already tried to do this
  89.     but in another way: Azatoth of Phenomena with his ProPacker, but it
  90.     changed the whole format and deleted all instrument names etc.
  91.       But by using OptiMod with the NewPM option, and then crunch/archive
  92.     them you'll gain about 10% than just crunching it.
  93.  
  94.     YOU'LL SAVE ABOUT 40-50% WITH   NEWPM OPTION + LhA   (by Stefan Boberg)
  95.  
  96.       But now with OptiMod you can optimize modules and they will sound
  97.     EXACTLY the same. OptiMod will try to do these things:
  98.  
  99.  
  100.     - Rearrange patterns to take less space.
  101.       ¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯
  102.         For instance by using pattern 0,1,2 & 6. All patterns in the middle
  103.       will be saved (3,4 & 5) but unused and empty. This will gain 1024
  104.       bytes per deleted pattern. OptiMod won't delete any used pattern.
  105.       As long as it's in the 'SongPositions' it will be left.
  106.         Duplicate patterns will be removed.
  107.  
  108.  
  109.     - Delete unused samples.
  110.       ¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯
  111.         Every unused but existing sample will be deleted.
  112.  
  113.  
  114.     - Cut away zeros in the end of Samples.
  115.       ¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯
  116.         If a instrument/sample ends with many zeros they will be cut away.
  117.       This will not affect how it sounds, if the zeros is in a loop they
  118.       will not be deleted. At least 2 zeros is always left to make the
  119.       sound not 'click' at the end.
  120.         Sample data after a loop is deleted. Watch out if you're using
  121.       the command to start playing a sample at a certain offset.
  122.  
  123.  
  124.     - Garbage
  125.       ¯¯¯¯¯¯¯
  126.         If the module contains garbage at the end of the module it will
  127.       be cut away. Some rippers save some bytes extra just in case. But
  128.       OptiMod will cut them. Please note that Garbage gain can be negative.
  129.         If it is negative the module wasn't correct at the start. OptiMod
  130.       will add some bytes were it should be. (Load it into ProTracker,
  131.       and you'll see the same result)
  132.  
  133.  
  134.     Optimod has also the ability to check who has done the module. If you
  135.     use the Verbose (No option), Short or Name mode you'll see the authors
  136.     name (if any). OptiMod will search thru all sample names for strings.
  137.  
  138.  
  139.  
  140.  5. READ THIS!!!
  141.  ¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯
  142.     DO NOT USE OPTIMOD ON MODULES THAT AREN'T FINISHED. THIS MAY CAUSE SOME
  143.     NOT YET INSERTED PATTERNS/SAMPLES TO BE DELETED!!!
  144.  
  145.     DON'T BLAME ME IF SOMETHING GOES WORNG, I HAVE NOTE YET FOUND A MODULE
  146.     THAT WERE CORRUPTED AFTER OPTIMIZING. AND I HAVE TESTED ON ABOUT 900 (!)
  147.     MODULES.
  148.  
  149.     THE MODULE WILL SOUND EXACTLY THE SAME AFTER OPTIMIZATION AS BEFORE!!!
  150.  
  151.     If OptiMod crashes or won't optimize a module correctly, please load it
  152.     into ProTracker and save it again.
  153.  
  154.     If newer versions of ProTracker changes the fileformat or adds new
  155.     advanced commands, I can't garantee OptiMod to work correctly!
  156.  
  157.  
  158.  
  159.  6. Template
  160.  ¯¯¯¯¯¯¯¯¯¯¯
  161.     OptiMod   SOURCE,DESTINATION,SHORT/S,SHORT2/S,MEDIUM/S,NAME/S,QUIET/S
  162.               NS=NOSAVE/S,NPAT=NOPATTERN/S,NSMP=NOSAMPLE/S
  163.               NSMPLEN=NOSAMPLELEN/S,NA=NOAUTHOR/S,NOPP/S,NOERROR/S
  164.               NEWPM/S,FX=EFFECT/S,BUG=UNWANTED/S,NOBUFF/S,SAMPLE=INSTR/S
  165.  
  166.     SOURCE         The module to optimize.
  167.  
  168.     DESTINATION    If omitted, the source will be the destination.
  169.  
  170.  
  171.     SHORT          This will list  FileSize before
  172.                                    FileSize after
  173.                                    Gain
  174.                                    SongLength. (Number of Positions)
  175.                                    Real Module name
  176.                                    Author
  177.  
  178.     SHORT2         This will list  FileSize after
  179.                                    Gain
  180.                                    SongLength. (Number of Positions)
  181.                                    How much percent with effects
  182.                                    Real Module name
  183.                                    Author
  184.  
  185.     MEDIUM         This will list  FileSize before
  186.                                    FileSize after
  187.                                    All four Gains (Pat/Smp/SamEnd/Garbage)
  188.                                    Total Gain
  189.                                    SongLength. (Number of Positions)
  190.                                    Real Module name
  191.  
  192.     NAME           This will list  Filename (no path)
  193.                                    Gain
  194.                                    Real Module name
  195.                                    Author
  196.  
  197.     QUIET          No output at all
  198.  
  199.     >> If none of these output modes are selected, the optimization will be
  200.        output in Verbose mode, and when I say verbose I mean VERBOSE!
  201.  
  202.     NOSAVE         Only examine, don't save the file.
  203.  
  204.  
  205.     NOPATTERN      Don't optimize patterns
  206.  
  207.     NOSAMPLE       Don't optimize samples usage
  208.  
  209.     NOSAMPLELEN    Don't optimize samples len
  210.  
  211.     NOAUTHOR       Don't show authors name
  212.  
  213.  
  214.     NOPP           Don't use powerpacker.library
  215.  
  216.     NOERROR        No returncode=20 whenever an error occurs.
  217.                    OM will return 20 if an error occurs, this
  218.                    will for example directly break any script
  219.                    file.
  220.  
  221.     NEWPM          This will convert the module into the new
  222.                    PowerMusic (see notes below) module format.
  223.                    The module will have the exact lenghts as
  224.                    a normal module, but when you pack with
  225.                    a packer/archiver it will be crunched better.
  226.                    OM will always output normal ProTracker
  227.                    module (except when the optimizationfailed
  228.                    and no file was generated) even if the
  229.                    source file was a PM-module. Keep that in mind.
  230.                    READ THE POWERMUSIC DOC FOR MORE INFO!!!
  231.  
  232.     EFFECT         This will show some information about how much all
  233.                    effect-commands are used. Both graphically and with
  234.                    numbers.
  235.  
  236.     UNWANTED       This will spot 'bugs' in a module! You can find any
  237.                    used but nonexisting sample. And nested pos-jumps
  238.                    which causes some positions not to be played.
  239.                    NoSave is automaticly enabled.
  240.                    USE IT BEFORE RELEASING ANY MODULE!!! Please...
  241.  
  242.     NOBUFF         I normal cases OptiMod will allocate a little extra
  243.                    bit of memory after the module, in case that the module
  244.                    are trashed and some instruments are missing. Then it
  245.                    will save zero's at the end istead of trash. By using
  246.                    this option you'll save some bytes of memory. Only use
  247.                    this if you're short of memory.
  248.  
  249.     INSTR          This will list all instruments. NoSave is automaticly
  250.                    enabled.
  251.  
  252.  
  253.     Please refer to any AmigaDos 2.0 Reference for more information
  254.     about Templates and modifiers.
  255.  
  256.  
  257.  
  258.  7. Examples
  259.  ¯¯¯¯¯¯¯¯¯¯¯
  260.     OptiMod mod.LetsRock ns             To just analyze the module.
  261.                                         Great for musicians.
  262.  
  263.     OptiMod mod.LetsTwist name newpm    Optimize module, save as the same
  264.                                         name as the Source. Show it in Name
  265.                                         output mode. Output file=PowerMusic
  266.  
  267.     OptiMod mod.LetsBoogie mod.LB nsmp  Optimize everything except sample
  268.                                         usage, and save as mod.LB.
  269.  
  270.  
  271.  
  272.  8. Tips about Usage
  273.  ¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯
  274.       It's smart to use OptiMod in conjunction with DirOpus, here is
  275.     two gadgets to use in DirOpus (v3.51+).
  276.  
  277.  
  278.     OptiModCheck
  279.  
  280.     Executable   OptiMod {f} nosave
  281.  
  282.     Flags:  Output window
  283.             CD source
  284.             Recursive directories
  285.             Do all files
  286.             Reload each time.
  287.  
  288.     CloseDelay: -1
  289.  
  290.  
  291.     - Directory Opus is Copyrighted by Jonathan Potter 1990-92 -
  292.                   - Published by INOVAtronics -
  293.  
  294.  
  295.  
  296.  9. Thanks
  297.  ¯¯¯¯¯¯¯¯¯
  298.     Thanks to:
  299.  
  300.       Peter 'Crayon' H   For his ProTracker. Get in touch if you wan't
  301.                          to include this in the ProTracker.
  302.  
  303.       Freelancers        Previous ProTrackers..
  304.  
  305.       Mahoney & Kaktus etc...  for all other Trackers.
  306.  
  307.  
  308.  
  309.       Robert Wahlström   For ßeta testing some of my programs.
  310.  
  311.       Nico François      For his two Great libraries (powerpacker
  312.                          & reqtools) which I have used in some
  313.                          of my other programs.
  314.  
  315.       Niklas Edmundsson  For helping me with a lot ßetatesting.
  316.  
  317.       Pierre Andersen    For some modules.
  318.  
  319.       Myself             For making this wonderful program.
  320.  
  321.  
  322.  
  323. 10. SHAREWARE
  324. ¯¯¯¯¯¯¯¯¯¯¯¯¯
  325.       This program is SHAREWARE, to get a version without the annoying
  326.     requester in the beginning you should get yourself registred. All
  327.     registred users will recieve a keyfile, this file will disable
  328.     the annoying requester in OptiMod AND in all future QTech Tools
  329.     programs which requires registration. As you recieve new versions,
  330.     (of OptiMod or other QTech Tools Programs) this keyfile will work
  331.     with them also. All distribution of the keyfile is totally forbidden!
  332.     The keyfile is personal.
  333.  
  334.       You're allowed to use this program for trial period no longer
  335.     than two weeks, if you find this program usable after that trial
  336.     period you must register yourself. Register yourself by sending
  337.     50 SEK or US$10 (by international money order/postal money order
  338.     in SEK, look at Registration Form for more info). As registred user
  339.     you'll get the latest version of OptiMod and other QTech Tools
  340.     availble. If a new version is under development I will wait until
  341.     it's ready before sending the programs/keyfile. Please remember that
  342.     a lot of time and money have been spend on OptiMod and other QTech
  343.     Tools. You SHOULD GET yourself REGISTRED now!
  344.  
  345.       Continuing to use OptiMod without being registred is both illegal
  346.     and inmoral! ...and #?$*&  :-)
  347.  
  348.       Use the Registration Form supplied with OptiMod!
  349.  
  350.  
  351.  
  352. 11. New version.
  353. ¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯
  354.      To recieve the latest version of OptiMod without registering just send
  355.    a disk full with some GREAT modules (preferable done by you, if you're
  356.    Good  :-> ) and some money for the stamp (optionally send a stamp). And
  357.    you'll recieve the latest version of OptiMod for free (except stamp)
  358.  
  359.      To just get the latest version you don't have to send in the registration
  360.    card.
  361.  
  362.  
  363.  
  364. 12. PowerMusic
  365. ¯¯¯¯¯¯¯¯¯¯¯¯¯¯
  366.      PowerMusic is a new and powerfull moduleplayer. It's the best
  367.    module player ever (That's true! Ask anyone!). Here are some functions.
  368.  
  369.    o Full xpk support. (Even password, priority etc)
  370.  
  371.    o Full PowerPacker support.
  372.  
  373.    o Full PowerPlayer module support. (PMC, thru lh.library)
  374.  
  375.    o Full LhA support. (That's GREAT)
  376.  
  377.    o Only for OS2.0+, uses some 3.0 functions if 3.0 is availible.
  378.  
  379.    o Handles only ProTracker (NoiseTracker) and PowerMusic-modules.
  380.  
  381.    o All ProTracker commands supported.
  382.  
  383.    o Full support of CIA timing.
  384.  
  385.    o Runs as a commodity.
  386.  
  387.    o Controllable thru JoyPort.
  388.  
  389.    o LongPlay function.
  390.  
  391.    o Rnd order of playing.
  392.  
  393.    o Nice Equalizer.
  394.  
  395.    o Own module format (PowerMusic-modules), which saves 10% of filelength.
  396.  
  397.    o LOTS of configuration things.
  398.  
  399.    o Nice to the system (allocates audiochannels, allocates interrupts.)
  400.  
  401.    o No known enforcer hits.
  402.  
  403.    o Written in 100% assembler = Fast!
  404.  
  405.    o Availble NOW! (Send me a disk with modules and I'll send you PowerMusic!)
  406.  
  407.  
  408. 13. How to contact me
  409. ¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯
  410.    Address:       Joakim Ögren  /Q-Tech
  411.                   Snipgränd 69
  412.                   S-90624 UMEÅ
  413.                   Sweden
  414.